License Properties

The attributes that make up a license code are known as license properties. The table below lists the various properties that can be set for version 11 licenses or later. Based on these properties, you may define your own license models that meet your business requirements.

You can find the license properties below as members of the CodeT structure defined in lscgen.h. The associated codeT member name is listed with each property name, such as feature_name, feature_version, and so on.

NOTE   For guidelines regarding reserved characters and strings, refer to License Generation API Reference Guide.

License Property Description Allowed in Long, Short-numeric, or both
Feature and version

Feature name
(feature_name)

A feature identifies a suite of applications, an application, a file, or a functionality of the software that needs to be licensed.

It can consist of alpha-numeric characters, without spaces, in the ASCII range of 32-126.

NOTE   You cannot use the following characters, as these are reserved for internal usage:

>Space (ASCII value 32)

>! (ASCII value 33)

># (ASCII value 35)

>$ (ASCII value 36)

Both

>Long: 24 characters

>Short-numeric: 6 numeric digits

Feature version
(feature_version)

Optionally, the licensed feature can also have a version associated with it.

It can consist of alpha-numeric characters, without spaces, in the ASCII range of 32-126.

NOTE   You cannot use the following characters, as these are reserved for internal usage:

>Space (ASCII value 32)

>! (ASCII value 33)

># (ASCII value 35)

>$ (ASCII value 36)

Long only

>Long: 11 characters

>Short-numeric: Not allowed

Single or multi-feature (key_type)

Specifies the license model as: single feature license or multi-feature license.

>Single feature: Both

>Multi-feature: Short-numeric only

Number of features
(num_features)

The number of multiple features in a license. The range for the number of features specified are:

>Minimum allowed = 2

>Maximum allowed = 63

Short-numeric only

 

License Type

Standalone/Network/Repository (standalone_flag)

Defines the license type depending on then deployment type:

 

For On-premises and Lease mode:

>Standalone License

>Network License

>Repository License

>Standalone: Both

>Network: Both

>Repository: Long only

Long or Short-numeric (code_type)

Determines the license code type. The possible types are:

>Long Licenses

>Short-numeric Licenses

NOTE   Short license codes are now only available for license versions earlier than 8.1.x.

--

 

 

 

Combining licenses (additive)

Determines how a new license will interact with a license already installed for this feature and version. They can be:

>Additive License

>Exclusive License

>Aggregate License

>Exclusive: Both

>Additive: Long only

>Aggregate: Long only

 

License output format
(out_lic_type)

Determines the format of the license generated. The possible options are:

>Encrypted License Code

>Concise Readable License Code

>Expanded Readable License Code

>Encrypted: Both

>Concise Readable: Long only

>Expanded Readable: Long only

Trial or normal license (licType)

Determines whether a license has trial properties associated (trial days and/or hours).

Both

License locking

License locking mode (client_server_lock_mode)

Determines the mode chosen for locking a license, including no-locking (unlocked). The options are:

>Client-server locked

>Client-locked

>Server-locked

>Unlocked

Both

Server locking criteria 1 and its information
(server_lock_info1)

The primary locking criteria for server-locked licenses.

Both

Server locking criteria 2 and its information
(server_lock_info2)

The secondary locking criteria for server-locked licenses.

Long only

Client locking criteria and information
(nl_client_lock_info)

The locking criteria for a client, for node-locked licensing.

Both

Local-request locking information
(local_request_lockcrit_flags)

The locking information for local request-based licenses, such as repository, grace, and commuter licenses.

Long only

License duration

Birth hours and minutes

(birth_hours and birth_minutes)

The license start time (in hours and minutes).

NOTE   These fields are relevant for version 16 (and above) licenses. If this field is set, the time and date values are interpreted as per the Coordinated Universal Time (UTC) standard.

Both, The default value is "NIL".

Birth day, month, and year

(birth_day, birth_month, and birth_year)

The license start date. If a beginning date is chosen for the license, the application will not run before that date (day, month, and year).

Long only.

Death hours and minutes
(death_hours and death_minutes)

The license end time (in hours and minutes).

NOTE   These fields are relevant for version 16 (and above) licenses. If this field is set, the time and date values are interpreted as per the Coordinated Universal Time (UTC) standard.

 

Death day, month, and year (death_day, death_month, and death_year)

The license expiration date. If an end date is chosen for a license, the license will become invalid after that date (day, month, and year).

Both. The default value is “never” (no limit). The maximum year value that can be specified is 2133.

Trial days
(trialDaysCount)

The number of days a trial license can last.

Both. The maximum value can be 1461 days.

Trial hours (trialHoursCount)

The number of hours a trial license can last.

Long only. The maximum value can be 35,064 hours.

License sharing

Sharing criteria
(sharing_crit)

Determines whether license token sharing is allowed for the feature or not. If allowed, then this value is the criteria chosen to share a license. The possible criteria are:

>User name - License sharing on the basis of a common user name.

>Host name - License sharing on the basis of the system where the licensed feature is being run.

>X-display ID - License sharing on the basis of the X-display ID of a UNIX or Linux ARM system.

>Vendor-defined - License sharing on the basis of a custom license sharing mechanism you implemented, which is registered using the VLSsetSharedId or VLSsetTeamId API function. The Unified API-based licensing implementations can set the sharing criteria using the SNTL_ATTR_APPCONTEXT_VENDOR_DEFINED_SHARINGID attribute of the sntl_licensing_app_context_new API.

Long only.

User Limit: number of tokens and application instances

Hard limit
(num_keys)

Specifies the number of license tokens available for concurrent use. The maximum number of license tokens is the hard limit.

Both

>Long: 4,294,967,294

>Short-numeric: 127

Soft limit
(soft_limit)

Specifies the number of license tokens at which to issue an alert or warning that the maximum number of licenses is approaching. Its value should not exceed the hard limit specified.

Long only: 4,294,967,294

Number of instances
(keys_per_node)

Controls the number of copies running on each client node (for client-locked and client/server-locked licenses).

Long only.

The maximum value can be 30 or infinite keys.

License key lifetime
Lifetime unit
(key_life_units)

The units or range using which lifetime value needs to be input. For example:

>Multiple of 1 minute(s), maximum 15 minutes

>Multiple of 10 minute(s), maximum 150 minutes

>Multiple of 30 minute(s), maximum 450 minutes

>Multiple of 60 minute(s), maximum 900 minutes

For more details, see Deciding License Token Lifetime.

Long only.

Lifetime value
(key_lifetime)

The lifetime value.

Long only.

License holdtime

Holdtime
(holding_crit)

Determines whether license token holding is allowed for the feature or not. For more details, see Deciding License Token Holdtime.

Long only.

Holdtime unit
(key_hold_units)

The units or range using which holdtime value needs to be input. For example:

>Multiple of 1 minute(s), maximum 15 minutes

>Multiple of 10 minute(s), maximum 150 minutes

>Multiple of 30 minute(s), maximum 450 minutes

>Multiple of 60 minute(s), maximum 900 minutes

Long only.

Holdtime value
(key_holdtime)

The holdtime value for which the key will be held for a client.

Long only.

Challenge-response

Number of secrets
(num_secrets)

Specifies the total number of secrets for the challenge-response mechanism. The maximum number of secrets that can be specified is seven.

Long only

Secrets
(secrets)

The secret strings for the challenge-response mechanism

Long only

Vendor details

Private information (vendor_info)

 

>The additional information that you can include as a part of your license code for identification. You may use it for keeping track of distributors or implementing a variety of licensing schemes.

>Private vendor information will remain encrypted in all license models (whether readable or encrypted).

Both

>For short-numeric license codes, only private information can be specified, not exceeding 98 characters.

>For long licenses codes, both public and private information can be specified. These cannot exceed 395 and 2000 characters, respectively.

>The commuter and grace licenses contain limited vendor information, up to 883 and 465 characters, respectively.

>The only exception to this are the redundant licenses, where the vendor information (both public and private) should not exceed 395 characters.

Public information
(plain_vendor_info)

The additional information that you can include as a part of your license code. It remains encrypted in encrypted licenses and readable in readable licenses, respectively.

Long only.

The public information cannot exceed 395 characters.

License vendor information

(license_vendor_info)

>This field is used for license aggregation by specifying different software vendor info, however, it does not participate in license aggregation. License vendor information is the additional information that you can include as a part of the license code for identification.

>This new field is applicable to version 19 licenses and above.

> License vendor information can be used for tracking distributors or implementing a variety of licensing schemes.

>License vendor information remains encrypted in all types of licenses (readable or encrypted).

Long only.

The license vendor information cannot exceed 512 characters.

License Manager redundancy

Number of redundant License Managers
(num_servers)

Specifies the maximum number of redundant License Managers in a subnet. The number of redundant License Managers can be a minimum of two (when the majority rule is not applied) or three (when the majority is applied) and a maximum of 11.

Long only

Majority rule
(majority_rule)

Specifies that majority of redundant License Managers must be running. If the number of redundant License Managers running is less than half of the number of License Managers specified in the license file, then all License Managers will stop servicing all old and new clients.

Long only

Commuter license

Commuter license or not (isCommuter)

Specifies whether a commuter license is allowed or not.

Long only

Maximum number of days for check-out
(commuter_max_checkout_days)

Specifies the maximum number of days a network license can be checked-out for. The maximum value cannot exceed 1827 days.

Long only

License Manager log file

Log encryption level
(log_encrypt_level)

Specifies the encryption level of the usage log file (created on the License Manager end for network licenses). You can choose from the following levels:

0 - Set the log encryption level to 0, when you want to allow the system administrator to set the encryption level (while starting the License Manager or through the LSERVOPTS environment variable). Now, if the administrator sets a value between 1-4, it will be applied. However, if the administrator does not set a value, then the encryption level of 2 will be set.

NOTE   If you do not set any level while generating the license, then 1 will be set. Your setting, between 1 to 4, will always override any level specified by the customer.

1 - Allows no encryption. Transaction data will be logged for this license code with no encryption.

2 - No encryption, tags each record with checksum. Transaction data will be readable by the customer, but tampering with or deleting an entry can be detected if the appropriate usage utility (lsusage or vusage) is run on the log file.

3 - Encrypt usage only. Transaction data will be readable by the customer except for license usage data (which will be encrypted), but tampering with or deleting an entry can be detected if the appropriate usage utility (lsusage or vusage) is run on the log file.

4 - Encrypt entire record. All transaction data for the license code will be encrypted. Tampering with or deleting an entry will not be prevented, but can be detected if the appropriate usage utility (lsusage or vusage) is run on the log file.

Few examples of log encryption levels:

>Vendor = Not set, System administrator = 1-4, Conclusion = 1

>Vendor = 0, System administrator = Not set, Conclusion = 2

>Vendor = 0, System administrator = 1-4, Conclusion = 1-4 as set by the administrator

>Vendor = 1-4, System administrator = 1-4, Conclusion = As set by the software vendor

>Vendor = 1-4 System administrator = Not set, Conclusion = As set by the software vendor

Long only

Site licensing

Number of subnets and information
(num_subnets and site_lic_info)

Specifies the number of subnets used for site licensing and their details.

Site-licensed applications can be locked to IP subnets. A subnet is specified using a wildcard notation. For instance, the subnet notation, 123.4.56.* refers to the subnet comprising all hosts whose IP addresses share the first three sub-addresses with the specified notation. Up to four wildcards can be used to specify a site, one in any sub-address position. Each notation can specify a group of subnets, for example, 123.*.56.*. Supported for long unlocked and server locked license codes.

NOTE   Site (subnet) licensing is not supported with IPv6 addresses.

Long only.

The maximum value can be 7.

Capacity

Capacity or not
(capacity_flag)

Decides whether the license capacity is allowed or not.

Long only.

Capacity units and value (capacity_units)

Specifies the units of capacity used to specify the capacity value. The options are:

>0 (Multiple of 1(s), maximum 1022)

>1 (Multiple of 10(s), maximum 10220

>2 (Multiple of 100(s), maximum 102200)

>3 (Multiple of 1000(s), maximum 1022000)

>4 (Multiple of 10000(s), maximum 10220000)

Long only.

Capacity
(capacity)

Specifies the capacity value as per the units specified in capacity_units.

Long only.

Grace

Grace allowed or not (grace_period_flag)

Defines whether a network license can have grace period enabled or not.

Under network licensing, the grace period allows running a licensed application even when the network is temporarily inaccessible. It provides continuity to use the application under unprepared circumstances such as network downtime or disconnection.

Long only.

Grace period in days (grace_period_calendar_days)

The grace period in the number of days.

Long only.

The default number of days is 2. The maximum value can be 180 days.

Grace period in hours (grace_period_elapsed_hours)

The grace period in the number of hours.

Long only.

The default number of hours is 20. The maximum value can be 1440 hours.

Time tampering

Clock tamper flag
(clock_tamper_flag)

You can specify whether licenses will be issued or not, if clock tampering is detected on a system.

When the License Manager detects that the clock is tampered, it does not grant a license for that feature. The License Manager will not exit on detection of tampering. Other features will continue to be served by the License Manager.

This check will be applied even if someone sets the clock back after starting the License Manager, and then dynamically adds a license.

Both.

By default, a license will not be issued on detection of time tampering for both the license models.

Virtual Machine Detection
VM detection flag
(vm_detection)

You can specify whether the license tokens will be issued or not, if the License Manager is found running on a virtual machine.

If you specify to deny the use of license tokens, then the License Manager will not exit on detection of virtual machine. Other features will continue to be served by the License Manager.

Long only.

By default, a license will be issued on detection of virtual machine for long license models.